Skip to content

refactor(bump): cleanup related to update_version_file#1594

Merged
Lee-W merged 3 commits intocommitizen-tools:v4-9-2from
bearomorphism:fix-regex
Nov 8, 2025
Merged

refactor(bump): cleanup related to update_version_file#1594
Lee-W merged 3 commits intocommitizen-tools:v4-9-2from
bearomorphism:fix-regex

Conversation

@bearomorphism
Copy link
Collaborator

@bearomorphism bearomorphism commented Sep 11, 2025 •
edited
Loading

Description

Try to address confusing variable names and function names, also reduced the number of function parameters for better readability.

Relate #1580

Better test coverage for update_version_in_file:

  • Covered return value
  • Covered check_consistency=True
  • Covered other encoding values

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

@bearomorphism bearomorphism force-pushed the fix-regex branch 3 times, most recently from 9e1cee1 to b1ec6b2 Compare September 11, 2025 17:40
@bearomorphism bearomorphism marked this pull request as ready for review September 11, 2025 17:41
bearomorphism
bearomorphism commented Sep 11, 2025
View reviewed changes
@codecov
Copy link

codecov bot commented Sep 11, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (v4-9-2@835ccb4). Learn more about missing BASE report.

Additional details and impacted files 
@@            Coverage Diff            @@
##             v4-9-2    #1594   +/-   ##
=========================================
  Coverage          ?   98.71%           
=========================================
  Files             ?       60           
  Lines             ?     2654           
  Branches          ?        0           
=========================================
  Hits              ?     2620           
  Misses            ?       34           
  Partials          ?        0
Flag Coverage Δ
unittests 98.71% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bearomorphism bearomorphism mentioned this pull request Sep 11, 2025
Closed
@bearomorphism bearomorphism force-pushed the fix-regex branch 3 times, most recently from 82fc109 to 10d5b2f Compare September 11, 2025 18:03
bearomorphism
bearomorphism commented Sep 11, 2025
View reviewed changes
commitizen/bump.py Outdated
file.write(version_file)
file.write(bumped_version_file_content)
updated.append(path)
return updated
Copy link
Collaborator Author

@bearomorphism bearomorphism Sep 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw the return value is not covered in the unit tests for this function. I'm not sure if it's covered anywhere else.

@Lee-W Lee-W added this to the 4.9.2 milestone Sep 11, 2025
bearomorphism
bearomorphism commented Sep 12, 2025
View reviewed changes
@bearomorphism bearomorphism force-pushed the fix-regex branch 2 times, most recently from 7e0a521 to 6ede88e Compare September 12, 2025 07:54
bearomorphism
bearomorphism commented Sep 12, 2025
View reviewed changes
@Lee-W Lee-W changed the base branch from master to v4-9-2 November 8, 2025 08:56
Lee-W
Lee-W approved these changes Nov 8, 2025
View reviewed changes
@Lee-W Lee-W modified the milestones: 4.10.1, 4.10.0 Nov 8, 2025
@Lee-W Lee-W merged commit e63600b into commitizen-tools:v4-9-2 Nov 8, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Lee-W Lee-W Lee-W approved these changes

@woile woile Awaiting requested review from woile

@noirbizarre noirbizarre Awaiting requested review from noirbizarre

Assignees

No one assigned

Labels

pr-status: wait-for-review type: refactor

Projects

None yet

Milestone

4.10.0

Development

Successfully merging this pull request may close these issues.

2 participants

@bearomorphism @Lee-W